Update gh-aw docs for setup prerequisites and triggers#1284
Update gh-aw docs for setup prerequisites and triggers#1284github-actions[bot] wants to merge 2 commits into
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
@copilot resolve the merge conflicts in this pull request |
Resolved the merge conflict in |
github-actions
Bot
added
the
small_boom
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Request changes: the updated documentation contains a workflow-layer claim that does not match the current source templates, and the new optional-Go prerequisite leaves the verification instructions failing on supported release setups.
What is this? | From workflow: Trigger PR Review
Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.
|
|
||
| 1. **Workflow** (`gh-aw-*.md` -> `gh-aw-*.lock.yml`): The agent logic, compiled by `gh-aw`. Triggers only on `workflow_call` with standard inputs (`additional-instructions`, `setup-commands`). | ||
| 2. **Trigger** (`<name>/example.yml`): A plain YAML file that defines the actual event triggers (schedule, PR events, slash commands, etc.) and calls the compiled `.lock.yml` via `uses:`. These serve as both examples for consumers and dogfood for this repo (copied to `.github/workflows/trigger-*.yml` by `scripts/dogfood.sh` for workflows not listed in `EXCLUDED_WORKFLOWS`). | ||
| 1. **Workflow** (`gh-aw-*.md` -> `gh-aw-*.lock.yml`): The agent logic, compiled by `gh-aw`. Workflows expose `workflow_call` with standard inputs (`additional-instructions`, `setup-commands`) and a `COPILOT_GITHUB_TOKEN` secret. Some source templates also declare direct comment/review/discussion triggers (`issue_comment`, `pull_request_review_comment`, `discussion_comment`) so the compiled workflow can be activated by reactions with the required permissions. |
There was a problem hiding this comment.
[P1] Please do not document direct event triggers or a COPILOT_GITHUB_TOKEN secret on source templates unless those files actually declare them. For example, .github/workflows/gh-aw-mention-in-pr.md:30-32 has only workflow_call, while gh-agent-workflows/mention-in-pr/example.yml:2-6 owns the issue_comment and pull_request_review_comment triggers; gh-agent-workflows/DEVELOPING.md:36 also states templates trigger only via workflow_call. As written, maintainers may edit the wrong layer and expect direct activation that never occurs.
| ## Prerequisites | ||
|
|
||
| - [Go](https://go.dev/dl/) — required by `make setup` to build the `gh-aw` compiler | ||
| - [Go](https://go.dev/dl/) — optional; only needed for non-release gh-aw compiler builds |
There was a problem hiding this comment.
[P2] Make the verification step consistent with the new optional prerequisite. On a clean release-based setup, make setup can install the official .bin/gh-aw without Go (see Makefile:143-146), but the next documented command still unconditionally runs go version at line 22 and fails when Go is absent. Please verify curl/wget (and optionally gh) here, or make the Go check conditional for source builds.
Summary
docs/developing.mdso gh-aw release builds documentcurl/wgetfor the official binary and make Go optional for non-release compiler builds.example.ymltrigger files.Validation
UV_CACHE_DIR=/tmp/gh-aw/agent/uv-cache make docs-buildCloses #1280.
What is this? | From workflow: Trigger Docs Patrol
Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.